MkPipDepTree

Show source on GitHub

Node to display a mermaid diagram for the dependencies.

ExamplesDocStringsBase classes⋔ Inheritance diagramNodeFileCode

Example: Regular

Jinja

{{ "jinja2" | MkPipDepTree }}

Python

MkPipDepTree('jinja2')

RenderedMarkdownHtml

graph TD
    classDef missing stroke-dasharray: 5
    jinja2["Jinja2\n3.1.5"]
    markupsafe["MarkupSafe\n3.0.2"]
    jinja2 -- ">=2.0" --> markupsafe

```` mermaid
graph TD
    classDef missing stroke-dasharray: 5
    jinja2["Jinja2\n3.1.5"]
    markupsafe["MarkupSafe\n3.0.2"]
    jinja2 -- ">=2.0" --> markupsafe
````

<pre class="mermaid"><code>graph TD
    classDef missing stroke-dasharray: 5
    jinja2["Jinja2\n3.1.5"]
    markupsafe["MarkupSafe\n3.0.2"]
    jinja2 -- "&gt;=2.0" --&gt; markupsafe</code></pre>

Bases: MkDiagram

__init__

__init__(
    package: ModuleType | str | None = None,
    *,
    direction: Literal["TD", "DT", "LR", "RL"] = "TD",
    local_only: bool = False,
    user_only: bool = False,
    include_editables: bool = True,
    editables_only: bool = False,
    **kwargs: Any
)

Parameters:

Name	Type	Description	Default
package	ModuleType | str | None	Package to show a dependency diagram for	None
direction	Literal['TD', 'DT', 'LR', 'RL']	diagram direction	'TD'
local_only	bool	Show ony local packages	False
user_only	bool	Show only user packages	False
include_editables	bool	Whether to include editable installs	True
editables_only	bool	Only return editable installs	False
kwargs	Any	Keyword arguments passed to parent	{}

Name	Children	Inherits
MkDiagram mknodes.basenodes.mkdiagram Class representing a mermaid diagram.	MkClassDiagram MkPipDepTree	MkCode

graph TD
  93860739173616["mkpipdeptree.MkPipDepTree"]
  93860742534992["mkdiagram.MkDiagram"]
  93860742841280["mkcode.MkCode"]
  93860744077920["mkcontainer.MkContainer"]
  93860744073616["mknode.MkNode"]
  93860744080896["node.Node"]
  140589822947552["builtins.object"]
  93860742534992 --> 93860739173616
  93860742841280 --> 93860742534992
  93860744077920 --> 93860742841280
  93860744073616 --> 93860744077920
  93860744080896 --> 93860744073616
  140589822947552 --> 93860744080896

/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkpipdeptree/metadata.toml

[metadata]
name = "MkPipDepTree"
icon = "mdi:dependency"
status = "new"
group = "documentation"

[requirements.package.pipdeptree]

[examples.regular]
title = "Regular"
jinja = """
{{ "jinja2" | MkPipDepTree }}
"""

# [examples.direction]
# title = "Directed"
# jinja = """
# {{ mk.MkPipDepTree(direction="LR") }}
# """

[output.markdown]
template = """
{{ node.fence_boundary }} mermaid
{{ node.text }}
{{ node.fence_boundary }}
"""

class MkPipDepTree(mkdiagram.MkDiagram):
    """Node to display a mermaid diagram for the dependencies."""

    REQUIRED_PACKAGES = [resources.Package("pipdeptree")]
    ICON = "material/dependency"

    def __init__(
        self,
        package: types.ModuleType | str | None = None,
        *,
        direction: Literal["TD", "DT", "LR", "RL"] = "TD",
        local_only: bool = False,
        user_only: bool = False,
        include_editables: bool = True,
        editables_only: bool = False,
        **kwargs: Any,
    ):
        """Constructor.

        Args:
            package: Package to show a dependency diagram for
            direction: diagram direction
            local_only: Show ony local packages
            user_only: Show only user packages
            include_editables: Whether to include editable installs
            editables_only: Only return editable installs
            kwargs: Keyword arguments passed to parent
        """
        self._package = package
        self.local_only = local_only
        self.user_only = user_only
        self.include_editables = include_editables
        self.editables_only = editables_only
        super().__init__(direction=direction, **kwargs)

    @property
    def package(self) -> str:
        match self._package:
            case None:
                return self.ctx.metadata.distribution_name
            case types.ModuleType():
                return self._package.__name__
            case _:
                return self._package

    @property
    def mermaid_code(self) -> str:
        return get_mermaid(
            self.package,
            local_only=self.local_only,
            user_only=self.user_only,
            include_editables=self.include_editables,
            editables_only=self.editables_only,
        )